Reduce stdout edge cases #297
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thompson-tomo
force-pushed
the
stdout_edge_cases
branch
from
ce5c072 to
ae002ff
Compare
thompson-tomo
force-pushed
the
stdout_edge_cases
branch
from
ae002ff to
6f05127
Compare
thompson-tomo
force-pushed
the
stdout_edge_cases
branch
from
e4baf20 to
2e474b3
Compare
Contributor
Author
|
@AndrewSouthpaw / @PeterDaveHello i have added logic to ensure --stdout is only used on a single file to help explain the use case for using stdout. Further improvements will come via seperate pr. |
Contributor
Author
|
@AndrewSouthpaw any concerns with reducing the edge cases with stdout? |
AndrewSouthpaw
requested changes
Jan 14, 2026
Co-authored-by: Andrew Smith <[email protected]>
thompson-tomo
force-pushed
the
stdout_edge_cases
branch
from
0728ed8 to
9b84256
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restricts the --stdout option to only work with single file processing, exiting with error code 2 if used with multiple files or directories. This addresses edge cases where stdout output would be ambiguous or unhelpful.
Changes:
- Added validation to reject
--stdoutusage with multiple files or directories - Updated test fixtures from
.mdto.logformat for stdout tests - Added new test case to verify error handling when
--stdoutis used with a directory - Updated README documentation to clarify
--stdoutlimitation
Reviewed changes
Copilot reviewed 4 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| doctoc.js | Adds validation logic to exit with error code 2 when --stdout is used with multiple files or directories |
| test/transform-stdout.js | Updates fixture file references from .md to .log and adds test for directory error case |
| test/fixtures/stdout.log | New fixture file containing expected stdout output for single file processing |
| test/fixtures/stdout_run_on_directory.log | New fixture file (appears unused) showing directory processing output |
| test/fixtures/invalid_stdout/readme.md | New test fixture directory with sample markdown file for testing error case |
| README.md | Documents that --stdout only works with single files |
| .gitignore | Adds exception to allow .log files in test/fixtures directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This ensures that the stdout option is only being used when a single file is being processed. If not a single file, switch to dryrun and log the switch.
Closes #112
Further adjustments to stdout will be handled via #296